Just putting this out here in draft form so people can try it out and critique the implementation. Many details to follow, but the general gist is to be able to interact with, and control, multiple connections from the main app or API.

See the README.md file for more details than you probably want...

Quick explanation of how to install and use:

• From the openbb_platform folder, run: dev_install.py -e
• Rebuild - openbb-build
• Create a new connection (as of right now, just Tiingo and FMP, but Polygon and Intrinio to follow)

obb.websockets.create_connection(provider="fmp", name="fmp_crypto", asset_type="crypto", symbol="btcusd")

This will create a new instance of the client, with the "name" being what is used to interact with from the router endpoints.

By default, a temp file hosts a SQL database, with a size limit of 300 rows, which will be discarded on exit, along with any open connections/threads. A broadcast server is also started on localhost using port 6666.

In a separate terminal, activate the obb environment and import the listener helper.

from openbb_websockets.listen import listen

listen("ws://127.0.0.1:6666")

You could have as many connections to the broadcast server as conditions allow.

You can get the validated results at any time from the main app with get_results

obb.websockets.get_results("fmp_crypto").to_df()

Subscribe and Unsubscribe events happen without interrupting the active stream, and the broadcast can be terminated without killing the provider connection. Providers will let you subscribe to any string, regardless of being a valid symbol, so "success" doesn't always mean that it will yield results. Some providers will allow subscribing to all, * . Tiingo with "all crypto" yields about 100-200 messages per second.

obb.websockets.subscribe("fmp_crypto", symbol="ethusd,solusd")

This is the contents of the router extension, "get_client" is excluded from the API.

In [4]: obb.websockets
Out[4]: 
/websockets
    clear_results
    create_connection
    get_client
    get_client_status
    get_results
    kill
    restart_connection
    start_broadcasting
    stop_broadcasting
    stop_connection
    subscribe
    unsubscribe

1. Why?:

   • To provide a way to work with various websocket connections in a non-blocking pattern.

2. What?:

3. Impact:

4. Testing Done:

5. Reviewer Notes (optional):

6. Any other information (optional)